home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1994 March / Internet Info CD-ROM (Walnut Creek) (March 1994).iso / networking / ip / ka9q / crh_n.arc / NANSI.DOC < prev    next >
Text File  |  1987-02-09  |  9KB  |  201 lines
  1. /***** hpcvmb:net.sources / topaz!dpz /  6:46 pm  May 10, 1986*/
  2.  
  3. nansi    - enhanced MS-DOS ansi console driver
  4.  
  5. SYNOPSIS
  6.         Include in \config.sys the line
  7.                 device=nansi.sys
  8.  
  9. DESCRIPTION
  10.         Nansi.sys is a console driver which understands ANSI control
  11.         sequences. It has several advantages over ANSI.SYS (the driver
  12.         supplied with DOS):
  13.         1. It supports new escape sequences (see below).
  14.         2. It provides MUCH faster output under certain conditions.
  15.         3. It supports the 43-line mode of the EGA.
  16.         4. The darned bell is now 1/4 second instead of 1/2 second long.
  17.  
  18.         What a console driver does:
  19.         When you, for example, type
  20.                 C:> type foo.txt
  21.         COMMAND.COM opens the file foo.txt, reads it, and writes it to
  22.         the console driver, which puts it up on the screen.
  23.  
  24.         Both ansi.sys and nansi.sys use IBM Video BIOS to control the screen.
  25.         However, nansi.sys bypasses BIOS if the screen is in a text mode; this
  26.         allows much faster operation under certain conditions.
  27.  
  28.         While putting text up on the screen, (n)ansi.sys keeps a lookout for
  29.         the escape character (chr(27), known as ESC); this character signals
  30.         the start of a terminal control sequence.
  31.         Terminal control sequences follow the format
  32.                 ESC [ param; param; ...; param cmd
  33.         where
  34.                 ESC     is the escape character chr$(27).
  35.                 [        is the left bracket character.
  36.                 param    is an ASCII decimal number, or a string in quotes.
  37.                 cmd     is a case-specific letter identifying the command.
  38.         Usually, zero, one, or two parameters are given.  If parameters
  39.         are omitted, they usually default to 1; however, some commands
  40.         (KKR and DKOCT) treat the no-parameter case specially.
  41.         Spaces are not allowed between parameters.
  42.  
  43.         For example, both ESC[1;1H and ESC[H send the cursor to the home
  44.         position (1,1), which is the upper left.
  45.  
  46.         Either single or double quotes may be used to quote a string.
  47.         Each character inside a quoted string is equivalent to one numeric
  48.         parameter.    Quoted strings are normally used only for the Keyboard
  49.         Key Reassignment command.
  50.  
  51. Control Sequences
  52.         The following table lists the sequences understood by nansi.sys.
  53.         Differences between nansi.sys and the standard ansi.sys are marked
  54.         with a vertical bar (|).
  55.  
  56. Cursor Positioning
  57. Short    Long name                Format            Notes
  58. CUP     cursor position         ESC[y;xH        Sets cursor position.
  59. HVP     cursor position         ESC[y;xf        Same as CUP; not recommended.
  60. CUU     cursor up                ESC[nA            n = # of lines to move
  61. CUD     cursor down             ESC[nB
  62. CUF     cursor forward            ESC[nC            n = # of columns to move
  63. CUB     cursor backward         ESC[nD
  64. DSR     Device Status, Report!    ESC[6n            Find out cursor position.
  65. CPR     Cursor Position report    ESC[y;xR        Response to DSR, as if typed.
  66. SCP     Save Cursor Position    ESC[s            Not nestable.
  67. RCP     Restore Cursor Position ESC[u
  68.  
  69. Editing
  70. ED        Erase in Display        ESC[2J    Clears screen.
  71. EL        Erase in Line            ESC[K    Clears to end of line.
  72. IL    |    Insert Lines            ESC[nL    Inserts n blank lines at cursor line.
  73. DL    |    Delete Lines            ESC[nM    Deletes n lines including cursor line.
  74. ICH |    Insert Characters        ESC[n@    Inserts n blank chars at cursor.
  75. DCH |    Delete Characters        ESC[nP    Deletes n chars including cursor char.
  76.  
  77.  
  78. Mode-Setting
  79. SGR     Set Graphics Rendition    ESC[n;n;...nm    See character attribute table.
  80. SM        Set Mode                ESC[=nh         See screen mode table.
  81. RM        Reset Mode                ESC[=nl         See screen mode table.
  82. IBMKKR    Keyboard Key Reass.     ESC["string"p
  83.         The first char of the string gives the key to redefine; the rest
  84.         of the string is the key's new value.
  85.         To specify unprintable chars, give the ASCII value of the char
  86.         outside of quotes, as a normal parameter.
  87.         IBM function keys are two byte strings; see the IBM Basic manual.
  88.         For instance, ESC[0;";dir a:";13;p redefines function key 1 to
  89.         have the value "dir a:" followed by the ENTER key.
  90.       | If no parameters given, all keys are reset to their default values.
  91.  
  92. DKOCT | Output char translate    ESC[n;ny
  93.       | When first char is encountered in output request, it is replaced with
  94.       | the second char.  This might be useful for previewing text before
  95.       | sending it to a printer with a funny print wheel.
  96.       | If no parameters are given, all chars are reset to normal.
  97.  
  98.  
  99. Character Attributes
  100.         The Set Graphics Rendition command is used to select foreground
  101.         and background colors or attributes.
  102.         When you use multiple parameters, they are executed in sequence, and
  103.         the effects are cumulative.
  104.            Attrib code            Value
  105.                 0                All attributes off (normal white on black)
  106.                 1                Bold
  107.                 4                Underline
  108.                 5                Blink
  109.                 7                Reverse Video
  110.                 8                Invisible (but why?)
  111.                 30-37            foregnd blk/red/grn/yel/blu/magenta/cyan/white
  112.                 40-47            background
  113.  
  114. Screen Modes
  115.         The IBM BIOS supports several video modes; the codes given in the
  116.         BIOS documentation are used as parameters to the Set Mode command.
  117.       | (In bitmap modes, the cursor is simulated with a small blob (^V).)
  118.             Mode Code            Value
  119.                 0                text 40x25 Black & White
  120.                 1                text 40x25 Color
  121.                 2                text 80x25 Black & White
  122.                 3                text 80x25 Color
  123.                 4                bitmap 320x200 4 bits/pixel
  124.                 5                bitmap 320x200 1 bit/pixel
  125.                 6                bitmap 640x200 1 bit/pixel
  126.                 7                (cursor wrap kludge)
  127.                 13 (EGA)        bitmap 320x200 4 bits/pixel ?
  128.                 14 (EGA)        bitmap 640x200 4 bits/pixel
  129.                 16 (EGA)        bitmap 640x350 4 bits/pixel
  130.         Mode 7 is an unfortunate kludge; Setting mode 7 tells the cursor
  131.         to wrap around to the next line when it passes the end of a line;
  132.         Resetting mode 7 tells the cursor to not wrap, but rather stay put.
  133.       | If your computer has the Enhanced Graphics Adaptor, modes between
  134.       | 8 and 15 are also supported; see the EGA BIOS for info.
  135.       | The EGA also lets you use a shorter character cell in text modes
  136.       | in order to squeeze 43 lines of text out of the 25-line text modes.
  137.       | To enter 43 line mode, set the desired 25-line text mode (0 to 3),
  138.       | then Set Mode 43.  For instance: ESC[=3h ESC[=43h.
  139.       | To exit 43 line mode, set the desired 25-line text mode again.
  140.       | Nansi.sys ignores mode 43 unless there is an EGA on your computer.
  141.  
  142. Faster Output
  143.       | Any program that sets the console to RAW mode, and buffers its
  144.       | output properly, can achieve extremely high screen update speeds in
  145.       | return for giving up the special functions of the keys ^C, ^S, and ^P.
  146.       | See IOCTL in the MS-DOS 3.x Technical Reference for more info.
  147.         Also, a small improvement in speed may be noticed with some
  148.         programs that use the DOS console in normal mode, as this driver
  149.         efficiently implements the (standard but undocumented) INT 29h
  150.         most-favored-device putchar used by DOS.
  151.  
  152. EXAMPLES
  153.         See the file setraw.doc for Macro Assembler, Lattice C,
  154.         and Microsoft C routines for entering and leaving raw mode.
  155.  
  156. BUGS
  157.         Insert and delete character do not work in graphics modes.
  158.         Graphics mode writing is slow.
  159.         The simulated cursor in graphics mode slows down single-char
  160.         writes by a factor of 3; it should be disable-able.
  161.         Does not support erase-to-end-of-screen and other useful functions.
  162.  
  163. Version
  164.         This version, 2.2, created February 1986.  Problems should
  165.         be reported to Daniel Kegel, 1-60 CIT, Pasadena, CA 91126
  166.         (or, after June 1986, 2648 169th Ave SE, Bellevue, Wa. 98008).
  167.         Your suggestions for improvement would be most welcome.
  168.  
  169. NOTE
  170.         This program may be distributed for educational and personal use
  171.         only.  Commercial use is verboten; get in touch with the author.
  172.  
  173. FILES
  174.         nansi.doc        - this file
  175.         nansi.hex        - compiled version    <Not supported by INFO-IBMPC>
  176.                 Convert nansi.hex into nansi.sys with the following commands
  177.                 (you'll end up with 256 extra bytes at end, but who cares?):
  178.                         debug                    # Run DOS debugger
  179.                         N nansi.hex             # Load the hex file
  180.                         L
  181.                         N nansi.sys             # Write it out
  182.                         W
  183.                         Q                        # Quit- back to DOS.
  184.         nansi.cat        - concatenated sources
  185.                 nansi    - makefile- shows how to assemble & link
  186.                 nansi.asm        - device driver guts
  187.                 nansi_d.asm     - definitions
  188.                 nansi_p.asm     - ANSI parameter grabber
  189.                 nansi_f.asm     - ANSI function handlers
  190.                 nansi_i.asm     - device driver init routine
  191.         setraw.cat        - concatenated examples
  192.                 setraw.asm        - for assembly programs
  193.                 setraw.msc        - for Microsoft C programs
  194.                 setraw.lc        - for Lattice C programs
  195.                 rawtest.lc        - example for Lattice C only
  196. -- 
  197. Name: David P. Zimmerman        Nickname: "Davidann" (don't ask)
  198. Cute quote: " (well, *I* think it's cute!)
  199. Arpa: dzimmerman@blue.rutgers.edu
  200. Uucp: ...{harvard, allegra, seismo}!topaz!dpz
  201.